home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_hylafax.idb / usr / freeware / sbin / faxcron.z / faxcron
Encoding:
Text File  |  1999-07-16  |  11.9 KB  |  467 lines
  1. #! /bin/sh
  2. #    $Id: faxcron.sh.in,v 1.41 1998/02/07 14:16:38 guru Rel $
  3. #
  4. # HylaFAX Facsimile Software
  5. #
  6. # Copyright (c) 1993-1996 Sam Leffler
  7. # Copyright (c) 1993-1996 Silicon Graphics, Inc.
  8. # HylaFAX is a trademark of Silicon Graphics
  9. # 
  10. # Permission to use, copy, modify, distribute, and sell this software and 
  11. # its documentation for any purpose is hereby granted without fee, provided
  12. # that (i) the above copyright notices and this permission notice appear in
  13. # all copies of the software and related documentation, and (ii) the names of
  14. # Sam Leffler and Silicon Graphics may not be used in any advertising or
  15. # publicity relating to the software without the specific, prior written
  16. # permission of Sam Leffler and Silicon Graphics.
  17. # 
  18. # THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  19. # EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  20. # WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  21. # 
  22. # IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  23. # ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  24. # OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  25. # WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  26. # LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  27. # OF THIS SOFTWARE.
  28. #
  29.  
  30. #
  31. # Script to run periodically from cron:
  32. #
  33. # 0. Print transmit and receive statistics.
  34. # 1. Purge info directory of old remote machine capabilities.
  35. # 2. Purge old session logs from the log directory.
  36. # 3. Purge old files in the received facsimile queue.
  37. # 4. Notify about sites that currently have jobs rejected.
  38. #
  39.  
  40. AGEINFO=30            # purge remote info after 30 days inactivity
  41. AGELOG=30            # keep log info for last 30 days
  42. AGERCV=7            # purge received facsimile after 2 days
  43. AGETMP=1            # purge orphaned temp files after 1 day
  44. FAXUSER=fax            # owner of log files
  45. LOGMODE=0644            # mode for log files
  46. XFERLOG=etc/xferlog        # HylaFAX xferlog file location
  47. LAST=etc/lastrun        # file where time+date of last run recorded
  48.  
  49. cd /usr/freeware/var/spool/fax            # NB: everything below assumes this
  50.  
  51. test -f etc/setup.cache || {
  52.     SPOOL=`pwd`
  53.     cat<<EOF
  54.  
  55. FATAL ERROR: $SPOOL/etc/setup.cache is missing!
  56.  
  57. The file $SPOOL/etc/setup.cache is not present.  This
  58. probably means the machine has not been setup using the faxsetup(1M)
  59. command.  Read the documentation on setting up HylaFAX before you
  60. startup a server system.
  61.  
  62. EOF
  63.     exit 1
  64. }
  65. . etc/setup.cache
  66.  
  67. RM="$RM -f"
  68. TEE=tee
  69. UPDATE="date +'%D %H:%M' >$LAST"
  70.  
  71. JUNK=/tmp/faxjunk$$        # temp file used multiple times
  72. AWKTMP=/tmp/faxawk$$        # temp file for awk program
  73.  
  74. while [ x"$1" != x"" ] ; do
  75.     case $1 in
  76.     -n)        RM=":" TEE=":" CP=":" MV=":" CHOWN=":" CHMOD=":" UPDATE=":";;
  77.     -l)        shift; LASTRUN="$1";;
  78.     -info)  shift; AGEINFO="$1";;
  79.     -log)   shift; AGELOG="$1";;
  80.     -rcv)   shift; AGERCV="$1";;
  81.     -tmp)   shift; AGETMP="$1";;
  82.     -mode)  shift; LOGMODE="$1";;
  83.     -*)        echo "Usage: $0 [-n] [-l lastrun] [-info days] [-log days] [-rcv days] [-tmp days] [-mode logmode]"; exit 1;;
  84.     esac
  85.     shift
  86. done
  87.  
  88. trap "$RM \$AWKTMP \$JUNK; exit 1" 0 1 2 15
  89.  
  90.  
  91. test -z "$LASTRUN" && LASTRUN=`$CAT $LAST 2>/dev/null`
  92.  
  93. echo "Facsimile transmitted since $LASTRUN:"
  94. echo ""
  95. $SBIN/xferstats -since "$LASTRUN" 
  96. echo ""
  97.  
  98. echo "Facsimile transmitted since last week:"
  99. echo ""
  100. $SBIN/xferstats -age 7
  101. echo ""
  102.  
  103. echo "Facsimile received since $LASTRUN:"
  104. echo ""
  105. $SBIN/recvstats -since "$LASTRUN" 
  106. echo ""
  107.  
  108. echo "Facsimile received since last week:"
  109. echo ""
  110. $SBIN/recvstats -age 7
  111. echo ""
  112.  
  113. echo "Report failed calls and associated session logs:"
  114. $CAT>$AWKTMP<<'EOF'
  115. #
  116. # Sort array a[l..r]
  117. #
  118. function qsort(a, l, r) {
  119.     i = l;
  120.     k = r+1;
  121.     item = a[l];
  122.     for (;;) {
  123.     while (i < r) {
  124.             i++;
  125.         if (a[i] >= item)
  126.         break;
  127.         }
  128.     while (k > l) {
  129.             k--;
  130.         if (a[k] <= item)
  131.         break;
  132.         }
  133.         if (i >= k)
  134.         break;
  135.     t = a[i]; a[i] = a[k]; a[k] = t;
  136.     }
  137.     t = a[l]; a[l] = a[k]; a[k] = t;
  138.     if (k != 0 && l < k-1)
  139.     qsort(a, l, k-1);
  140.     if (k+1 < r)
  141.     qsort(a, k+1, r);
  142. }
  143.  
  144. function cleanup(s)
  145. {
  146.     gsub("\"", "", s);
  147.     gsub("^ +", "", s);
  148.     gsub(" +$", "", s);
  149.     return s;
  150. }
  151.  
  152. function setupToLower()
  153. {
  154.     upperRE = "[ABCDEFGHIJKLMNOPQRSTUVWXYZ]";
  155.     upper["A"] = "a"; upper["B"] = "b"; upper["C"] = "c";
  156.     upper["D"] = "d"; upper["E"] = "e"; upper["F"] = "f";
  157.     upper["G"] = "g"; upper["H"] = "h"; upper["I"] = "i";
  158.     upper["J"] = "j"; upper["K"] = "k"; upper["L"] = "l";
  159.     upper["M"] = "m"; upper["N"] = "n"; upper["O"] = "o";
  160.     upper["P"] = "p"; upper["Q"] = "q"; upper["R"] = "r";
  161.     upper["S"] = "s"; upper["T"] = "t"; upper["U"] = "u";
  162.     upper["V"] = "v"; upper["W"] = "w"; upper["X"] = "x";
  163.     upper["Y"] = "y"; upper["Z"] = "z";
  164. }
  165.  
  166. function toLower(s)
  167. {
  168.     if (match(s, upperRE) != 0) {
  169.     do {
  170.         c = substr(s, RSTART, 1);
  171.         gsub(c, upper[c], s);
  172.     } while (match(s, upperRE));
  173.     }
  174.     return s;
  175. }
  176.  
  177. #
  178. # Accumulate a statistics record.
  179. #
  180. function acct(dest, status, datetime, commid)
  181. {
  182.     split(datetime, a, " ");
  183.     split(a[1], b, "/");
  184.     t = b[3] b[1] b[2] a[2];
  185.     if (t < LASTt)
  186.     return;
  187.     status = cleanup(status);
  188.     if (length(status) > 11) {
  189.     msg = toLower(substr(status, 1, 11));
  190.     if (callFailed[msg])
  191.         return;
  192.     }
  193.     if (status != "") {
  194.     dest = cleanup(dest);
  195.     datetime = cleanup(datetime);
  196.     for (i = 0; i < nerrmsg; i++)
  197.         if (errmsg[i] == status)
  198.         break;
  199.     if (i == nerrmsg)
  200.         errmsg[nerrmsg++] = status;
  201.     if (errinfo[dest] == "")
  202.         errinfo[dest] = datetime "@" i "/" commid;
  203.     else
  204.         errinfo[dest] = errinfo[dest] "|" datetime "@" i "/" commid;
  205.     }
  206. }
  207.  
  208. function printOldTranscript(canon, datetime)
  209. {
  210.     gsub("[^0-9]", "", canon);
  211.     split(datetime, parts, " ");
  212.     split(parts[1], p, "/");
  213.     cmd = sprintf(TRANSCRIPT, canon, months[p[1]], p[2], parts[2]);
  214.     system(cmd);
  215. }
  216.  
  217. function printTranscript(commid)
  218. {
  219.     printf "\n    ---- Transcript of session follows ----\n\n"
  220.     comFile = "log/c" commid;
  221.     if ((getline <comFile) > 0) {
  222.     do {
  223.         if (index($0, "-- data") == 0)
  224.         print $0
  225.     } while ((getline <comFile) > 0);
  226.     close(comFile);
  227.     } else
  228.     print "No transcript available.";
  229. }
  230.  
  231. BEGIN        { FS="\t";
  232.           callFailed["busy signal"] = 1;
  233.           callFailed["unknown pro"] = 1;
  234.           callFailed["no carrier "] = 1;
  235.           callFailed["no local di"] = 1;
  236.           callFailed["no answer f"] = 1;
  237.           callFailed["job aborted"] = 1;
  238.           callFailed["invalid dia"] = 1;
  239.           callFailed["can not loc"] = 1;
  240.           months["01"] = "Jan"; months["02"] = "Feb";
  241.           months["03"] = "Mar"; months["04"] = "Apr";
  242.           months["05"] = "May"; months["06"] = "Jun";
  243.           months["07"] = "Jul"; months["08"] = "Aug";
  244.           months["09"] = "Sep"; months["10"] = "Oct";
  245.           months["11"] = "Nov"; months["12"] = "Dec";
  246.  
  247.           split(LASTRUN, a, " ");
  248.           split(a[1], b, "/");
  249.           LASTt = b[3] b[1] b[2] a[2];
  250.           setupToLower();
  251.         }
  252. $2 == "SEND" && NF == 9  { acct($4,  $9, $1, ""); }
  253. $2 == "SEND" && NF == 11 { acct($5, $11, $1, ""); }
  254. $2 == "SEND" && NF == 12 { acct($6, $12, $1, ""); }
  255. $2 == "SEND" && NF == 13 { acct($7, $13, $1, $3); }
  256. $2 == "SEND" && NF == 14 { acct($7, $14, $1, $3); }
  257. END        { nsorted = 0;
  258.           for (key in errinfo)
  259.               sorted[nsorted++] = key;
  260.           qsort(sorted, 0, nsorted-1);
  261.           for (k = 0; k < nsorted; k++) {
  262.               key = sorted[k];
  263.               n = split(errinfo[key], a, "|");
  264.               for (i = 1; i <= n; i++) {
  265.               if (split(a[i], b, "@") != 2)
  266.                   continue;
  267.               if (split(b[2], d, "/") != 2)
  268.                   continue;
  269.               printf "\n"
  270.               printf "To: %-16.16s  Date: %s\n", key, b[1]
  271.               printf "Error: %s\n\n", errmsg[d[1]]
  272.  
  273.               if (d[2] == "")
  274.                   printOldTranscript(key, b[1]);
  275.               else
  276.                   printTranscript(d[2]);
  277.               }
  278.           }
  279.         }
  280. EOF
  281. $AWK -f $AWKTMP -v LASTRUN="$LASTRUN" TRANSCRIPT="\
  282.     LOGFILE=log/%s;\
  283.     TMP=/tmp/faxlog\$\$;\
  284.     if [ -f \$LOGFILE ]; then\
  285.     $SED -n -e '/%s %s %s.*SESSION BEGIN/,/SESSION END/p' \$LOGFILE |\
  286.     $SED -e '/start.*timer/d'\
  287.          -e '/stop.*timer/d'\
  288.          -e '/-- data/d'\
  289.          -e 's/^/    /' >\$TMP;\
  290.     fi;\
  291.     if [ -s \$TMP ]; then\
  292.     $CAT \$TMP;\
  293.     else\
  294.     echo '    No transcript available.';\
  295.     fi;\
  296.     rm -f \$TMP\
  297.     " $XFERLOG
  298. echo ""
  299.  
  300. #
  301. # Collect phone numbers that haven't been called
  302. # in the last $AGEINFO days.  We use this to clean
  303. # up the info files.
  304. #
  305. find info -ctime +$AGEINFO -print >$JUNK
  306.  
  307. if [ -s $JUNK ]; then
  308. echo "Purge remote device capabilities older than $AGEINFO days:"
  309. INFOTMP=info/tmp$$
  310. for i in `$CAT $JUNK`; do
  311.     if $GREP '^&' $i >/dev/null 2>&1; then
  312.     echo "    $i (saving locked down values)"
  313.     $SED '/^[^&]/d' $i > $INFOTMP
  314.     $MV $INFOTMP $i; $CHOWN ${FAXUSER} $i; $CHMOD ${LOGMODE} $i
  315.     elif [ -f $i ]; then
  316.     echo "    $i"
  317.     $RM $i
  318.     fi
  319. done
  320. $RM $INFOTMP            # for -n option
  321. else 
  322.     echo "Nothing to purge in info directory."
  323. fi
  324. echo ""
  325.  
  326. find log -mtime +$AGELOG -print >$JUNK
  327. if [ -s $JUNK ]; then
  328.     echo "Purge session logs older than $AGELOG days:"
  329.     for i in `$CAT $JUNK`; do
  330.     echo "    Remove $i"
  331.     $RM $i
  332.     done
  333.     echo ""
  334. fi
  335.  
  336. echo "Truncate merged session logs older than $AGELOG days:"
  337.  
  338. $CAT>$AWKTMP<<'EOF'
  339. #
  340. # Setup date conversion data structures.
  341. #
  342. function setupDateTimeStuff()
  343. {
  344.     Months["Jan"] =  0; Months["Feb"] =  1; Months["Mar"] =  2;
  345.     Months["Apr"] =  3; Months["May"] =  4; Months["Jun"] =  5;
  346.     Months["Jul"] =  6; Months["Aug"] =  7; Months["Sep"] =  8;
  347.     Months["Oct"] =  9; Months["Nov"] = 10; Months["Dec"] = 11;
  348.  
  349.     daysInMonth[ 0] = 31; daysInMonth[ 1] = 28; daysInMonth[ 2] = 31;
  350.     daysInMonth[ 3] = 30; daysInMonth[ 4] = 31; daysInMonth[ 5] = 30;
  351.     daysInMonth[ 6] = 31; daysInMonth[ 7] = 31; daysInMonth[ 8] = 30;
  352.     daysInMonth[ 9] = 31; daysInMonth[10] = 30; daysInMonth[11] = 31;
  353.  
  354.     FULLDAY = 24 * 60 * 60;
  355. }
  356.  
  357. #
  358. # Convert MMM DD hh:mm:ss.ms to seconds.
  359. # NB: this does not deal with leap years.
  360. #
  361. function cvtTime(s)
  362. {
  363.     mon = Months[substr(s, 0, 3)];
  364.     yday = substr(s, 5, 2) - 1;
  365.     for (i = 0; i < mon; i++)
  366.     yday += daysInMonth[i];
  367.     s = substr(s, 7);
  368.     t = i = 0;
  369.     for (n = split(s, a, ":"); i++ < n; )
  370.     t = t*60 + a[i];
  371.     return yday*FULLDAY + t;
  372. }
  373.  
  374. BEGIN            { setupDateTimeStuff();
  375.               KEEP = cvtTime(TODAY) - AGE*FULLDAY;
  376.               lastRecord = "$"
  377.             }
  378.             { if (cvtTime($1 ":" $2 ":" $3) >= KEEP) {
  379.                   lastRecord = NR; exit
  380.               }
  381.             }
  382. END            { print lastRecord }
  383. EOF
  384. TODAY="`date +'%h %d %T'`"
  385.  
  386. for i in log/[0-9]*; do
  387.     if [ -f $i ]; then
  388.     START=`$AWK -F: -f $AWKTMP -v TODAY="$TODAY" -v AGE=$AGELOG $i` 2>/dev/null
  389.     if [ "$START" != 1 ]; then
  390.         $SED 1,${START}d $i >$JUNK
  391.         if [ -s $JUNK ]; then
  392.         $MV $JUNK $i; $CHOWN ${FAXUSER} $i; $CHMOD ${LOGMODE} $i
  393.         ls -ls $i
  394.         else
  395.         echo "    Remove empty $i"
  396.         $RM $i
  397.         fi
  398.     fi
  399.     fi
  400. done
  401. echo ""
  402.  
  403. #
  404. # Purge old stuff from the receive queue.
  405. #
  406. find recvq -mtime +$AGERCV -print >$JUNK
  407. if [ -s $JUNK ]; then
  408.     echo "Purge received facsimile older than $AGERCV days:"
  409.     (for i in `$CAT $JUNK`; do
  410.     $SBIN/faxinfo $i
  411.     $RM $i >/dev/null 2>&1
  412.     done) | $AWK -F: '
  413. /recvq.*/    { file=$1; }
  414. /Sender/    { sender = $2; }
  415. /Pages/        { pages = $2; }
  416. /Quality/    { quality = $2; }
  417. /Received/    { date = $2;
  418.           for (i = 3; i <= NF; i++)
  419.               date = date ":" $i;
  420.           printf "    %-16.16s %21.21s %2d %8s%s\n", \
  421.             file, sender, pages, quality, date;
  422.         }
  423. '
  424. else
  425.     echo "Nothing to purge in receive queue."
  426. fi
  427. echo ""
  428.  
  429. #
  430. # Purge old stuff from the temp directory.
  431. #
  432. find tmp -type f -mtime +$AGETMP -print >$JUNK
  433. if [ -s $JUNK ]; then
  434.     echo "Purge tmp files older than $AGETMP days:"
  435.     for i in `$CAT $JUNK`; do
  436.       if [ -f $i ]; then
  437.     echo "    Remove $i"
  438.     $RM $i
  439.       fi
  440.     done
  441. else
  442.     echo "Nothing to purge in the tmp directory."
  443. fi
  444. echo ""
  445.  
  446. #
  447. # Note destinations whose jobs are currently being rejected.
  448. #
  449. find info cinfo -newer $LAST -print 2>/dev/null >$JUNK
  450. if [ -s $JUNK ]; then
  451.     echo "Destinations being rejected (added since $LASTRUN):"
  452.     $GREP "^rejectNotice:" `$CAT $JUNK` | $AWK -F: '
  453.         { reason = $3;
  454.           for (i = 4; i <= NF; i++)
  455.             reason = reason ":" $i;
  456.           sub("^[ ]*", "", reason);
  457.           if (reason != "") {
  458.               sub(".*/", "", $1);
  459.               printf "Rejecting jobs to +%s because \"%s\".\n", \
  460.                 $1, reason;
  461.           }
  462.         }
  463. '
  464. fi
  465.  
  466. $RM $LAST; eval $UPDATE
  467.